

AMPlayAPI
~~~~~~~~~

This is a quick test rig for testing AMPlay's response to particular
wimp messages. It's of use to AMPlay developers who have extended
AMPlay's API, and wish to verify that their extension is working.

It is possibly also of some use for developers who are writing their
own applications (possibly just for their own use) that send
AMPlay API messages (although you'll probably find richer pickings in
AMPlayCmd).

In the flags field, enter the decimal value of the flags you wish to
send (256=normal, 257=don'treply, 258=replybyfile). The default value
of 256 should be correct for most purposes. Enter the three character
command string, and any required parameters in the relevant boxes,
and click send. If the parameters are integers rather than strings,
tick the integer box. (Flags are always sent as integers, and the +36
parameter is always sent as a string).

Except for the string at +36, any strings you enter must be 3
characters or less. The interface will allow you to enter more
characters than this (because you might need to enter integers of more
than 3 digits), but any such long strings will be trimmed to their
first three characters in the sent message.

The section below will report the response, if any, from AMPlay.

The reply is interpreted as;

- Flags are expanded into their textual meaning. i.e. bit 10 set will
  result in a 'file not found' text in the +20 (flags) field.

- Only responses for which the relevant bit is set are reported. i.e
  if there is a bug such that a particular reply contains an integer
  at +24, but fails to set the flag indicating that there is data
  there, the text 'not present' is reported. (Obviously, this also
  applies if there is genuinely no response in a particular field)

You can set the flag to request reply by file, but AMPlayAPI will not
notice the reply. The output will be present in PipeFS to read
manually.

For example code that uses the reply by file mechanism, refer to
AMPlayCMD

You can send;

- AMPlay Commands. Things to get amplay to do something.
- AMPlay requests. Ways of getting amplay to return some information.
- AMPlayCfg Commands. Things to get AMPlayCfg to do something.

For what commands to use, and what parameters are allowed, refer to
the section on the API in the AMPlay documentation.

________________________________________________________________________


Version History:
~~~~~~~~~~~~~~~~

2.00 First version. (Version number to match the other AMPlay v2
components)

2.00a Minor update. Fixed the !Run file to load ABCLib correctly if
it wasn't already

________________________________________________________________________
Copyright  2005 Mike Sandells, mike@mikejs.com
Last Modified: 31.10.2005
